WebsocketCodec

Undocumented in source.

Constructors

this
this(TransportDirection direc, HTTPTransaction txn)
Undocumented in source.

Members

Enums

ProcessingState
enum ProcessingState
Undocumented in source.

Functions

checkValidity
bool checkValidity()
Undocumented in source. Be warned that the author may not have intended to support it.
clear
void clear()
Undocumented in source. Be warned that the author may not have intended to support it.
createStream
StreamID createStream()
Undocumented in source. Be warned that the author may not have intended to support it.
detach
void detach(HTTPTransaction txn)
Undocumented in source. Be warned that the author may not have intended to support it.
doMask
bool doMask()
Undocumented in source. Be warned that the author may not have intended to support it.
generateBody
size_t generateBody(HTTPTransaction txn, HttpWriteBuffer chain, ubyte[] data, bool eom)
Undocumented in source. Be warned that the author may not have intended to support it.
generateChunkHeader
size_t generateChunkHeader(HTTPTransaction txn, HttpWriteBuffer buffer, size_t length)
Undocumented in source. Be warned that the author may not have intended to support it.
generateChunkTerminator
size_t generateChunkTerminator(HTTPTransaction txn, HttpWriteBuffer buffer)
Undocumented in source. Be warned that the author may not have intended to support it.
generateEOM
size_t generateEOM(HTTPTransaction txn, HttpWriteBuffer buffer)
Undocumented in source. Be warned that the author may not have intended to support it.
generateHeader
size_t generateHeader(HTTPTransaction txn, HTTPMessage msg, HttpWriteBuffer buffer, bool eom)
Undocumented in source. Be warned that the author may not have intended to support it.
generateMaskingKey
ubyte[4] generateMaskingKey()
Undocumented in source. Be warned that the author may not have intended to support it.
generateRstStream
size_t generateRstStream(HTTPTransaction txn, HttpWriteBuffer buffer, HTTPErrorCode code)
Undocumented in source. Be warned that the author may not have intended to support it.
generateWsFrame
size_t generateWsFrame(HTTPTransaction txn, HttpWriteBuffer buffer, OpCode code, ubyte[] data)
Undocumented in source. Be warned that the author may not have intended to support it.
getFrameHeader
void getFrameHeader(OpCode code, size_t payloadLength, bool lastFrame, HttpWriteBuffer buffer)
Undocumented in source. Be warned that the author may not have intended to support it.
getProtocol
CodecProtocol getProtocol()
Undocumented in source. Be warned that the author may not have intended to support it.
getTransportDirection
TransportDirection getTransportDirection()
Undocumented in source. Be warned that the author may not have intended to support it.
isBusy
bool isBusy()
Undocumented in source. Be warned that the author may not have intended to support it.
isOpCodeReserved
bool isOpCodeReserved(OpCode code)
Undocumented in source. Be warned that the author may not have intended to support it.
onConnectClose
void onConnectClose()
Undocumented in source. Be warned that the author may not have intended to support it.
onIngress
size_t onIngress(ubyte[] buf)
Undocumented in source. Be warned that the author may not have intended to support it.
onTimeOut
void onTimeOut()
Undocumented in source. Be warned that the author may not have intended to support it.
readFrame
void readFrame(ubyte[] data)
Undocumented in source. Be warned that the author may not have intended to support it.
setCallback
void setCallback(CallBack callback)
Undocumented in source. Be warned that the author may not have intended to support it.
setParserPaused
void setParserPaused(bool paused)
Undocumented in source. Be warned that the author may not have intended to support it.
shouldClose
bool shouldClose()
Undocumented in source. Be warned that the author may not have intended to support it.

Inherited Members

From HTTPCodec

StreamID
alias StreamID = uint

Key that uniquely identifies a request/response pair within (and only within) the scope of the codec. Code outside the codec should regard the StreamID as an opaque data structure; different subclasses of HTTPCodec are likely to use different conventions for generating StreamID values.

CallBack
interface CallBack
Undocumented in source.
getProtocol
CodecProtocol getProtocol()
Undocumented in source.
createStream
StreamID createStream()
Undocumented in source.
getTransportDirection
TransportDirection getTransportDirection()

Get the transport direction of this codec: DOWNSTREAM if the codec receives requests from clients or UPSTREAM if the codec sends requests to servers.

supportsStreamFlowControl
bool supportsStreamFlowControl()

Returns true iff this codec supports per stream flow control

supportsSessionFlowControl
bool supportsSessionFlowControl()

Returns true iff this codec supports session level flow control

setCallback
void setCallback(CallBack callback)

Set the callback to notify on ingress events @param callback The callback object

isBusy
bool isBusy()

Check whether the codec still has at least one HTTP stream to parse.

shouldClose
bool shouldClose()
Undocumented in source.
setParserPaused
void setParserPaused(bool paused)

Pause or resume the ingress parser @param paused Whether the caller wants the parser to be paused

onIngress
size_t onIngress(ubyte[] buf)

Parse ingress data. @param buf A single IOBuf of data to parse @return Number of bytes consumed.

onConnectClose
void onConnectClose()
Undocumented in source.
onTimeOut
void onTimeOut()
Undocumented in source.
detach
void detach(HTTPTransaction txn)
Undocumented in source.
generateHeader
size_t generateHeader(HTTPTransaction txn, HTTPMessage msg, HttpWriteBuffer buffer, bool eom)

Write an egress message header. For pushed streams, you must specify the assocStream. @retval size the size of the generated message, both the actual size and the size of the uncompressed data. @return None

generateBody
size_t generateBody(HTTPTransaction txn, HttpWriteBuffer chain, ubyte[] data, bool eom)

Write part of an egress message body.

generateChunkHeader
size_t generateChunkHeader(HTTPTransaction txn, HttpWriteBuffer buffer, size_t length)

Write a body chunk header, if relevant.

generateChunkTerminator
size_t generateChunkTerminator(HTTPTransaction txn, HttpWriteBuffer buffer)

Write a body chunk terminator, if relevant.

generateEOM
size_t generateEOM(HTTPTransaction txn, HttpWriteBuffer buffer)

Generate any protocol framing needed to finalize an egress message. This method must be called to complete a stream.

generateRstStream
size_t generateRstStream(HTTPTransaction txn, HttpWriteBuffer buffer, HTTPErrorCode code)

Generate any protocol framing needed to abort a connection. @return number of bytes written

generateWsFrame
size_t generateWsFrame(HTTPTransaction txn, HttpWriteBuffer buffer, OpCode code, ubyte[] data)
Undocumented in source. Be warned that the author may not have intended to support it.
getProtocolFormString
CodecProtocol getProtocolFormString(string str)
Undocumented in source. Be warned that the author may not have intended to support it.

Meta